<?php
    /*********************************************************************************
     * Zurmo is a customer relationship management program developed by
     * Zurmo, Inc. Copyright (C) 2014 Zurmo Inc.
     *
     * Zurmo is free software; you can redistribute it and/or modify it under
     * the terms of the GNU Affero General Public License version 3 as published by the
     * Free Software Foundation with the addition of the following permission added
     * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
     * IN WHICH THE COPYRIGHT IS OWNED BY ZURMO, ZURMO DISCLAIMS THE WARRANTY
     * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
     *
     * Zurmo is distributed in the hope that it will be useful, but WITHOUT
     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
     * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
     * details.
     *
     * You should have received a copy of the GNU Affero General Public License along with
     * this program; if not, see http://www.gnu.org/licenses or write to the Free
     * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
     * 02110-1301 USA.
     *
     * You can contact Zurmo, Inc. with a mailing address at 27 North Wacker Drive
     * Suite 370 Chicago, IL 60606. or at email address contact@zurmo.com.
     *
     * The interactive user interfaces in original and modified versions
     * of this program must display Appropriate Legal Notices, as required under
     * Section 5 of the GNU Affero General Public License version 3.
     *
     * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
     * these Appropriate Legal Notices must retain the display of the Zurmo
     * logo and Zurmo copyright notice. If the display of the logo is not reasonably
     * feasible for technical reasons, the Appropriate Legal Notices must display the words
     * "Copyright Zurmo Inc. 2014. All rights reserved".
     ********************************************************************************/

    /**
     * Helper class to get a collection of attributes
     * from the model. If the attribute is a relation model attribute, the attribute name will be setup like
     * relation__attributeName, where relation is model's relation name, and attributeName is the attributeName on the
     * relation model.
     */
    class ModelAttributeImportMappingCollectionUtil
    {
        /**
         * Takes a collection and attribute properties
         * and populates the collection with that attribute.
         * @return null;
         */
        public static function populateCollection(
            & $collection,
            $attributeIndex,
            $attributeLabel,
            $attributeName,
            $elementType,
            $relationAttributeName = null,
            $isRequired = false)
        {
            assert('is_array ($collection)');
            assert('is_string($attributeIndex)          && $attributeIndex != null');
            assert('is_string($attributeLabel)          && $attributeLabel != null');
            assert('is_string($attributeName)           && $attributeName != null');
            assert('is_string($elementType)             && $elementType != null');
            assert('is_string($relationAttributeName)   || $relationAttributeName == null');
            assert('is_bool($isRequired)');

            $collection[$attributeIndex] = array(
                'attributeLabel'            => $attributeLabel,
                'attributeName'             => $attributeName,
                'relationAttributeName'     => $relationAttributeName,
                'attributeImportRulesType'  => $elementType,
                'isRequired'                => $isRequired,
            );
        }
    }
?>